<!-- HTML header for doxygen 1.8.10-->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
    <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8" />
    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
    <meta name="generator" content="Doxygen 1.8.10" />
    <title>ZRDDS: ContentFilteredTopic接口 参考</title>
    <link href="tabs.css" rel="stylesheet" type="text/css" />
    <script type="text/javascript" src="jquery.js"></script>
    <script type="text/javascript" src="dynsections.js"></script>
    <link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
    <link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
    <link href="doxygen.css" rel="stylesheet" type="text/css" />
    <link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
    <link href="static/css/bootstrap.css" rel="stylesheet" />
    <!-- <link href="static/css/sticky-footer-navbar.css" rel="stylesheet">
    <script type="text/javascript" src="static/js/bootstrap.js"></script> -->
    <script type="text/javascript" src="static/js/doxy-boot.js"></script>
</head>
<body>
    <div id="top">
        <!-- do not remove this div, it is closed by doxygen! -->
        <!-- end header part --><!-- 制作者 Doxygen 1.8.10 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'搜索');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>首页</span></a></li>
      <li><a href="pages.html"><span>相关页面</span></a></li>
      <li><a href="namespaces.html"><span>包</span></a></li>
      <li class="current"><a href="annotated.html"><span>类</span></a></li>
      <li><a href="examples.html"><span>示例</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="搜索" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>类列表</span></a></li>
      <li><a href="classes.html"><span>类索引</span></a></li>
      <li><a href="hierarchy.html"><span>类继承关系</span></a></li>
      <li><a href="functions.html"><span>类成员</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('interfacecom_1_1zrdds_1_1topic_1_1_content_filtered_topic.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public 成员函数</a> &#124;
<a href="interfacecom_1_1zrdds_1_1topic_1_1_content_filtered_topic-members.html">所有成员列表</a>  </div>
  <div class="headertitle">
<div class="title">ContentFilteredTopic接口 参考</div>  </div>
</div><!--header-->
<div class="contents">

<p>抽象基于内容过滤的主题。  
 <a href="interfacecom_1_1zrdds_1_1topic_1_1_content_filtered_topic.html#details">更多...</a></p>
<div class="dynheader">
类 ContentFilteredTopic 继承关系图:</div>
<div class="dyncontent">
 <div class="center">
  <img src="interfacecom_1_1zrdds_1_1topic_1_1_content_filtered_topic.png" usemap="#ContentFilteredTopic_map" alt=""/>
  <map id="ContentFilteredTopic_map" name="ContentFilteredTopic_map">
<area href="interfacecom_1_1zrdds_1_1topic_1_1_topic_description.html" title="抽象主题的基本属性信息。 " alt="TopicDescription" shape="rect" coords="0,0,129,24"/>
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public 成员函数</h2></td></tr>
<tr class="memitem:ace4616ee0846163705b0e2eb97fb2ebb"><td class="memItemLeft" align="right" valign="top">String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacecom_1_1zrdds_1_1topic_1_1_content_filtered_topic.html#ace4616ee0846163705b0e2eb97fb2ebb">get_filter_expression</a> ()</td></tr>
<tr class="memdesc:ace4616ee0846163705b0e2eb97fb2ebb"><td class="mdescLeft">&#160;</td><td class="mdescRight">获取当前基于内容过滤的主题关联的过滤表达式。  <a href="#ace4616ee0846163705b0e2eb97fb2ebb">更多...</a><br /></td></tr>
<tr class="separator:ace4616ee0846163705b0e2eb97fb2ebb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2caefa0281c7ded86c2f99db6b31d5af"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classcom_1_1zrdds_1_1infrastructure_1_1_return_code__t.html">ReturnCode_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacecom_1_1zrdds_1_1topic_1_1_content_filtered_topic.html#a2caefa0281c7ded86c2f99db6b31d5af">get_expression_parameters</a> (<a class="el" href="classcom_1_1zrdds_1_1infrastructure_1_1_string_seq.html">StringSeq</a> paras)</td></tr>
<tr class="memdesc:a2caefa0281c7ded86c2f99db6b31d5af"><td class="mdescLeft">&#160;</td><td class="mdescRight">该方法获取关联的过滤参数，在创建基于内容过滤的主题时传入或者通过 <a class="el" href="interfacecom_1_1zrdds_1_1topic_1_1_content_filtered_topic.html#ad6fa8e39717ceb30dd0cb4a7fbb14774" title="该方法用于重新设置过滤参数。 ">ContentFilteredTopic.set_expression_parameters</a> 方法设置。  <a href="#a2caefa0281c7ded86c2f99db6b31d5af">更多...</a><br /></td></tr>
<tr class="separator:a2caefa0281c7ded86c2f99db6b31d5af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad6fa8e39717ceb30dd0cb4a7fbb14774"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classcom_1_1zrdds_1_1infrastructure_1_1_return_code__t.html">ReturnCode_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacecom_1_1zrdds_1_1topic_1_1_content_filtered_topic.html#ad6fa8e39717ceb30dd0cb4a7fbb14774">set_expression_parameters</a> (<a class="el" href="classcom_1_1zrdds_1_1infrastructure_1_1_string_seq.html">StringSeq</a> paras)</td></tr>
<tr class="memdesc:ad6fa8e39717ceb30dd0cb4a7fbb14774"><td class="mdescLeft">&#160;</td><td class="mdescRight">该方法用于重新设置过滤参数。  <a href="#ad6fa8e39717ceb30dd0cb4a7fbb14774">更多...</a><br /></td></tr>
<tr class="separator:ad6fa8e39717ceb30dd0cb4a7fbb14774"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a82ad95c1d59fdc8060e137228ce5eaf7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfacecom_1_1zrdds_1_1topic_1_1_topic.html">Topic</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacecom_1_1zrdds_1_1topic_1_1_content_filtered_topic.html#a82ad95c1d59fdc8060e137228ce5eaf7">get_related_topic</a> ()</td></tr>
<tr class="memdesc:a82ad95c1d59fdc8060e137228ce5eaf7"><td class="mdescLeft">&#160;</td><td class="mdescRight">获取该基于内容过滤主题的基础主题，在使用 DomainParticipant.create_contentfilertopic 创建时指定。  <a href="#a82ad95c1d59fdc8060e137228ce5eaf7">更多...</a><br /></td></tr>
<tr class="separator:a82ad95c1d59fdc8060e137228ce5eaf7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_interfacecom_1_1zrdds_1_1topic_1_1_topic_description"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_interfacecom_1_1zrdds_1_1topic_1_1_topic_description')"><img src="closed.png" alt="-"/>&#160;Public 成员函数 继承自 <a class="el" href="interfacecom_1_1zrdds_1_1topic_1_1_topic_description.html">TopicDescription</a></td></tr>
<tr class="memitem:a8c40e1ae55b47723dd2c2b0533f5e04b inherit pub_methods_interfacecom_1_1zrdds_1_1topic_1_1_topic_description"><td class="memItemLeft" align="right" valign="top">String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacecom_1_1zrdds_1_1topic_1_1_topic_description.html#a8c40e1ae55b47723dd2c2b0533f5e04b">get_type_name</a> ()</td></tr>
<tr class="memdesc:a8c40e1ae55b47723dd2c2b0533f5e04b inherit pub_methods_interfacecom_1_1zrdds_1_1topic_1_1_topic_description"><td class="mdescLeft">&#160;</td><td class="mdescRight">获取与该主题关联的数据类型在域参与者中注册的名称。  <a href="#a8c40e1ae55b47723dd2c2b0533f5e04b">更多...</a><br /></td></tr>
<tr class="separator:a8c40e1ae55b47723dd2c2b0533f5e04b inherit pub_methods_interfacecom_1_1zrdds_1_1topic_1_1_topic_description"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc01cc28cec62cbb4169f7afb610670b inherit pub_methods_interfacecom_1_1zrdds_1_1topic_1_1_topic_description"><td class="memItemLeft" align="right" valign="top">String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacecom_1_1zrdds_1_1topic_1_1_topic_description.html#acc01cc28cec62cbb4169f7afb610670b">get_name</a> ()</td></tr>
<tr class="memdesc:acc01cc28cec62cbb4169f7afb610670b inherit pub_methods_interfacecom_1_1zrdds_1_1topic_1_1_topic_description"><td class="mdescLeft">&#160;</td><td class="mdescRight">获取该主题的名称。  <a href="#acc01cc28cec62cbb4169f7afb610670b">更多...</a><br /></td></tr>
<tr class="separator:acc01cc28cec62cbb4169f7afb610670b inherit pub_methods_interfacecom_1_1zrdds_1_1topic_1_1_topic_description"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf90ca6583c2753d9db443c19773ebfe inherit pub_methods_interfacecom_1_1zrdds_1_1topic_1_1_topic_description"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfacecom_1_1zrdds_1_1domain_1_1_domain_participant.html">DomainParticipant</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacecom_1_1zrdds_1_1topic_1_1_topic_description.html#abf90ca6583c2753d9db443c19773ebfe">get_participant</a> ()</td></tr>
<tr class="memdesc:abf90ca6583c2753d9db443c19773ebfe inherit pub_methods_interfacecom_1_1zrdds_1_1topic_1_1_topic_description"><td class="mdescLeft">&#160;</td><td class="mdescRight">获取创建该主题所属的域参与者。  <a href="#abf90ca6583c2753d9db443c19773ebfe">更多...</a><br /></td></tr>
<tr class="separator:abf90ca6583c2753d9db443c19773ebfe inherit pub_methods_interfacecom_1_1zrdds_1_1topic_1_1_topic_description"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1289595c0f0c4ece0a1ce1ce017a1b66 inherit pub_methods_interfacecom_1_1zrdds_1_1topic_1_1_topic_description"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfacecom_1_1zrdds_1_1topic_1_1_topic.html">Topic</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacecom_1_1zrdds_1_1topic_1_1_topic_description.html#a1289595c0f0c4ece0a1ce1ce017a1b66">get_topic</a> ()</td></tr>
<tr class="separator:a1289595c0f0c4ece0a1ce1ce017a1b66 inherit pub_methods_interfacecom_1_1zrdds_1_1topic_1_1_topic_description"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">详细描述</h2>
<div class="textblock"><p>抽象基于内容过滤的主题。 </p>
<p>基于内容的过滤主题是更复杂的主题抽象，表明订阅端不需要主题下的所有数据，而只关心满足一定条件的数据。 基于内容过滤的主题可以用来限制订阅端需要处理的数据量，以及减少网络内发送的数据量（发布端过滤）。 通过过滤表达式以及过滤参数来表示订阅端需要的数据。过滤表达式与SQL语句中的WHERE块类似， 而过滤参数则提供值给过滤表达式中的参数（使用n表示），提供的过滤参数的个数需与过滤表达式中要求的参数一致。 过滤表达式以及过滤参数的语法参见 <a class="el" href="index.html#expression-grammer">语法规则</a> 。</p>
<p>注意： ZRDDS该版本的过滤在订阅端应用，故而基于内容过滤的主题不会减少网络带宽，反而会增加接收端的负载（每个样本 均需要应用用户设置的过滤规则）。 </p>
</div><h2 class="groupheader">成员函数说明</h2>
<a class="anchor" id="a2caefa0281c7ded86c2f99db6b31d5af"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classcom_1_1zrdds_1_1infrastructure_1_1_return_code__t.html">ReturnCode_t</a> get_expression_parameters </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classcom_1_1zrdds_1_1infrastructure_1_1_string_seq.html">StringSeq</a>&#160;</td>
          <td class="paramname"><em>paras</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>该方法获取关联的过滤参数，在创建基于内容过滤的主题时传入或者通过 <a class="el" href="interfacecom_1_1zrdds_1_1topic_1_1_content_filtered_topic.html#ad6fa8e39717ceb30dd0cb4a7fbb14774" title="该方法用于重新设置过滤参数。 ">ContentFilteredTopic.set_expression_parameters</a> 方法设置。 </p>
<dl class="params"><dt>参数</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in,out]</td><td class="paramname">paras</td><td>出口参数，用于保存通信中间件维护的过滤参数。</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>返回</dt><dd>如下的可能返回值：<ul>
<li><a class="el" href="classcom_1_1zrdds_1_1infrastructure_1_1_return_code__t.html#a5d7e5ebc74fcef92e1d4489ff2ef098d" title="执行成功。 ">ReturnCode_t.RETCODE_OK</a> :表示成功；</li>
<li><a class="el" href="classcom_1_1zrdds_1_1infrastructure_1_1_return_code__t.html#ab74ac22c8cc8d89bc6fd1f2221a5272d" title="执行出错。 ">ReturnCode_t.RETCODE_ERROR</a> :未知的错误表示失败，例如拷贝参数失败。 </li>
</ul>
</dd></dl>

</div>
</div>
<a class="anchor" id="ace4616ee0846163705b0e2eb97fb2ebb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">String get_filter_expression </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>获取当前基于内容过滤的主题关联的过滤表达式。 </p>
<dl class="section return"><dt>返回</dt><dd>过滤表达式字符串。 </dd></dl>

</div>
</div>
<a class="anchor" id="a82ad95c1d59fdc8060e137228ce5eaf7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="interfacecom_1_1zrdds_1_1topic_1_1_topic.html">Topic</a> get_related_topic </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>获取该基于内容过滤主题的基础主题，在使用 DomainParticipant.create_contentfilertopic 创建时指定。 </p>
<dl class="section return"><dt>返回</dt><dd>指向该基于内容过滤的主题关联的基础主题。 </dd></dl>

</div>
</div>
<a class="anchor" id="ad6fa8e39717ceb30dd0cb4a7fbb14774"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classcom_1_1zrdds_1_1infrastructure_1_1_return_code__t.html">ReturnCode_t</a> set_expression_parameters </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classcom_1_1zrdds_1_1infrastructure_1_1_string_seq.html">StringSeq</a>&#160;</td>
          <td class="paramname"><em>paras</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>该方法用于重新设置过滤参数。 </p>
<dl class="params"><dt>参数</dt><dd>
  <table class="params">
    <tr><td class="paramname">paras</td><td>指明新的过滤参数。</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>返回</dt><dd>如下的可能返回值：<ul>
<li><a class="el" href="classcom_1_1zrdds_1_1infrastructure_1_1_return_code__t.html#a5d7e5ebc74fcef92e1d4489ff2ef098d" title="执行成功。 ">ReturnCode_t.RETCODE_OK</a> :表示成功；</li>
<li><a class="el" href="classcom_1_1zrdds_1_1infrastructure_1_1_return_code__t.html#a954f75a236a7a535d4da2723bb453677" title="不正确的参数。 ">ReturnCode_t.RETCODE_BAD_PARAMETER</a> :表示过滤参数个数或者类型与过滤表达式不匹配；</li>
<li><a class="el" href="classcom_1_1zrdds_1_1infrastructure_1_1_return_code__t.html#ab74ac22c8cc8d89bc6fd1f2221a5272d" title="执行出错。 ">ReturnCode_t.RETCODE_ERROR</a> :未知的错误表示失败，例如拷贝参数失败。 </li>
</ul>
</dd></dl>

</div>
</div>
<hr/>该接口的文档由以下文件生成:<ul>
<li>ContentFilteredTopic.java</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.10-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><b>com</b></li><li class="navelem"><b>zrdds</b></li><li class="navelem"><a class="el" href="namespacecom_1_1zrdds_1_1topic.html">topic</a></li><li class="navelem"><a class="el" href="interfacecom_1_1zrdds_1_1topic_1_1_content_filtered_topic.html">ContentFilteredTopic</a></li>
    <li class="footer">
      <a href="http://www.zrtechnology.com">&copy; Copyright (c) 2018 ZhenRong Technology, Inc. All rights reserved.</a>
    </li>
  </ul>
</div>
</body>
</html>
